/*
 * Copyright (c) 2024 Alibaba Group Holding Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.fluss.fs.token;

/**
 * FileSystem security token receiver API. Currently, instances of {@link SecurityTokenReceiver}s
 * are loaded in client side through service loader.
 */
public interface SecurityTokenReceiver {

    /** Scheme of the filesystem to receive security tokens for. This name should be unique. */
    String scheme();

    /**
     * Callback function when new security tokens obtained.
     *
     * @param token security token obtained
     */
    void onNewTokensObtained(ObtainedSecurityToken token) throws Exception;
}
